v4 iOS API
Contents
기본 iOS API
본 문서는 한화시스템/ICT의 HONE Smart Platform 제품 중 3버전 이하의 iOS Client에서는 HONE Javascript API에서 제공하는 기능과 동일한 iOS API를 제공하고 있다.
기본 iOS API 목록은 다음과 같다.
Table. 기본 iOS API 목록
| Service | Class | Action | Remark |
|---|---|---|---|
| authentication | DAPAuthentication | doLogin | 서버에 로그인을 수행한다 |
| doLogout | 서버에 로그아웃을 수행한다. | ||
| camera | DAPCamera | takePicture | 카메라가 사용 가능한 경우 카메라로 촬영 후 단말기에 저장되어 있는 사진 또는 직접 사진 촬영을 통해 사진을 얻거나 내장앨범으로부터 사진을 얻는다. |
| contact | DAPContact | find | 검색어를 이용하여 검색 대상 필드의 해당 주소록 목록을 반환한다. |
| add | 전달된 정보를 주소록에 추가한다. | ||
| remove | 주소록을 삭제한다. | ||
| device | DAPDevice | getDeviceInfo | 단말기의 정보를 반환한다. |
| getAppInfo | 현재 사용 중인 앱에 대한 정보와 설치된 BizApp의 정보를 반환한다. | ||
| getNetworkInfo | 현 네트워크의 상태 값을 반환한다. | ||
| getLocale | 현 로케일 정보를 반환한다. | ||
| filerepository | DAPFileRepository | save | 원본 파일을 로컬 저장 후 저장된 파일의 정보를 JSON Object 형태로 반환한다. |
| find | 로컬에 저장된 파일을 검색한 후 검색 내용을 배열 형태로 반환한다. | ||
| remove | 로컬에 저장된 파일을 삭제한다. | ||
| geolocation | DAPGeolocation | getCurrentPosition | 현재 위치정보를 반환한다. |
| watchPosition | 현재 위치정보를 주기적으로 반환한다. | ||
| clear | 동작 중인 watch를 종료한다. | ||
| network | DAPNetwork | doPost | 서버에 업무 데이터를 전송한다. |
| doUpload | 서버에 파일을 업로드 한다. | ||
| doDownload | 서버로부터 파일을 다운로드 한다. | ||
| doUploadWithProgress | 서버에 파일을 업로드하면서 진행상태를 출력한다. | ||
| doDownloadWithProgress | 서버로부터 파일을 다운로드하면서 진행상태를 출력한다. | ||
| preference | DAPPreference | get | 단말이 제공하는 Preference로부터 Key에 해당되는 값을 반환한다. |
| set | 단말이 제공하는 Preference에 Key, Value값을 전달받아 저장한다. | ||
| remove | 단말이 제공하는 Preference로부터 Key값의 내용을 삭제한다. | ||
| sqlite | DAPSqlite | open | 지정된 이름으로 데이터베이스를 Open한다. |
| close | 지정된 이름의 데이터베이스를 Close한다. | ||
| executePragmaStatement | 데이터베이스에 파라미터로 전달된 쿼리문을 실행한다. | ||
| executeSqlBatch | 파라미터로 전달된 쿼리문들을 순차적으로 실행한다. | ||
| window | DAPWindow | showWindow | 윈도우를 출력 및 이동한다. |
| sendMessage | 윈도우 간에 메시지를 전달한다. | ||
| hasWindow | 윈도우 생성 여부를 확인한다. | ||
| destroyWindow | 생성 된 윈도우를 삭제한다. | ||
| clearCache | Cache를 삭제한다. | ||
| goBack | 윈도우 매니저가 관리하는 정보를 기반으로 이전 화면으로 이동한다. | ||
| canGoBack | 윈도우 매니저가 관리하는 정보를 기반으로 이동할 이전 화면이 존재하는 지 확인한다. | ||
| goForward | 윈도우 매니저가 관리하는 정보를 기반으로 다음 화면으로 이동한다. | ||
| canGoForward | 윈도우 매니저가 관리하는 정보를 기반으로 이동할 다음 화면이 존재하는 지 확인한다. | ||
| alert | 경고 화면을 출력한다. | ||
| confirm | 확인 화면을 출력한다. | ||
| showLoadingScreen | 로딩 화면을 출력한다. | ||
| hideLoadingScreen | 출력 중인 로딩 화면을 숨긴다. | ||
| orientation | 단말기의 orientation 정보를 반환한다. | ||
| exitApp | 앱을 종료한다. | ||
| getWindow | 전달된 윈도우 아이디에 해당하는 Window 객체를 반환한다. | ||
| currentWindow | 현재 윈도우 객체를 반환한다. | ||
Add-on iOS API
아래의 Add-on iOS API는 별도 라이브리러로 제공되어 해당 API를 제공받기 위해선 해당하는 framework를 개발 프로젝트에 포함시켜야 한다.
Add-on iOS API 목록은 다음과 같다.
Table. Add-on iOS API 목록
| Service | Class | Action | Remark | Version |
|---|---|---|---|---|
| applinker | DAPAppLinker | start | 앱 링크를 실행한다. | ▲3.0.0 |
| barcode | DAPBarcode | show | 바코드 리더화면을 출력한다. | ▲2.6.4 |
| beacon | DAPBeacon | startScan | 주변의 Beacon 신호 정보를 검색한다. | ▲4.2.8 |
| stopScan | Beacon 정보 검색을 종료 한다. | |||
| clipboard | DAPClipboard | set | 클립보드에 데이터를 저장한다. | ▲3.0.0 |
| get | 클립보드에 저장되어 있는 데이터를 얻는다. | |||
| fingerprint | DAPFingerprint | authenticate | 지문 인증을 요청한다. | ▲3.0.0 |
| flashlight | DAPFlashlight | on | 플래쉬를 켠다. | ▲3.0.0 |
| off | 플래쉬를 끈다. | |||
| gallery | DAPGallery | open | 이미지/동영상을 선택할 수 있는 갤러리를 실행한다. | ▲3.0.0 |
| lockscreen | DAPLockscreen | createPincode | 잠금번호를 생성한다. | ▲3.1.1 |
| show | 잠금화면을 출력한다. | |||
| changePincode | 잠금번호를 변경한다. | |||
| hasPincode | 잠금번호 생성여부를 확인한다. | |||
| log | DAPLog | 로그를 디버깅 화면에 출력한다. | ▲3.0.0 | |
| motion | DAPMotion | getCurrent | 현재 단말의 동작 정보를 얻는다. | ▲3.0.0 |
| watch | 현재 단말 동작 정보를 주기적으로 얻는다. | |||
| clearWatch | 동작중인 watch를 종료한다. | |||
| nfc | DAPNfc | read | NFC 테그 정보를 읽어온다. | ▲4.2.8 |
| notice | DAPNotice | get | 공지사항 정보를 서버로부터 받아온다. | ▲2.6.4 |
| show | 공지사항 화면을 출력한다. | |||
| screen | DAPScreen | brightness | 화면 밝기를 설정한다. | ▲3.0.0 |
| capture | 화면을 캡처한다. | ▲3.7.13 | ||
| securestorage | DAPSecureStorage | set | 암호화 저장소에 key, value 형태로 데이터를 저장한다. | ▲3.1.1 |
| get | 암호화 저장소에 key에 해당하는 값을 전달받는다. | |||
| remove | 암호화 저장소에 key에 해당하는 값을 삭제한다. | |||
| vibrator | DAPVibrator | vibrate | 단말에 진동을 발생시킨다. (기본 350ms 시간 동안 동작한다. | ▲3.0.0 |
| window | DAPWindow | fullscreen | 전체 화면으로 출력한다. | ▲3.0.0 |
| isFullscreen | 전체 화면 출력 여부를 반환한다. | |||
| orientation | 단말기의 orientation 정보를 반환한다. | |||
| openapi | DAPOpenApi | getAddress | 도로명 주소를 받아온다. | ▲3.7.13 |
| getWeather | 특정 위치의 날씨 정보를 받아온다. | |||
| getAir | 특정 위치의 미세먼지 정보를 받아온다. | |||
| getSearch | 검색어의 검색 결과를 출력한다. | |||
| crashreport | DAPCrashreport | recordReport | 예외 및 오류를 기록 한다. | ▲4.7.15 |
| recordLog | 예외에 대한 정보를 자세히 파악하기 위해 앱에 커스텀 로그를 추가 한다.. | |||
| net | DAPNet | request | Operation 또는 Hub 와의 네트워크 통신 기능을 제공한다. | ▲4.15.27 |